<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>py2ecotect.doc.selection.Selection</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="py2ecotect-module.html">Package&nbsp;py2ecotect</a> ::
        <a href="py2ecotect.doc-module.html">Package&nbsp;doc</a> ::
        <a href="py2ecotect.doc.selection-module.html">Module&nbsp;selection</a> ::
        Class&nbsp;Selection
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="py2ecotect.doc.selection.Selection-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Selection</h1><p class="nomargin-top"><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">Selection</strong>
</pre>

<hr />
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#delete" class="summary-sig-name">delete</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Deletes the currently selected object(s) from the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.delete">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#duplicate" class="summary-sig-name">duplicate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Creates a duplicate copy of currently selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.duplicate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#equation" class="summary-sig-name">equation</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Recalculates the plane equations and surface areas of currently 
      selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.equation">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#extrude" class="summary-sig-name">extrude</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Extrudes currently selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.extrude">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#group" class="summary-sig-name">group</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Establishes a group for the currently selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.group">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#link" class="summary-sig-name">link</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Creates inter-object relationship links between the currently 
      selected objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.link">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#move" class="summary-sig-name">move</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">offset_distance</span>)</span><br />
      Moves the currently selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.move">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#normal" class="summary-sig-name">normal</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>)</span><br />
      Orients the surface normals of all currently selected objects in the 
      specified direction.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.normal">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#nudge" class="summary-sig-name">nudge</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">dir</span>)</span><br />
      Nudges the currently selected objects along the given axis direction.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.nudge">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#orient" class="summary-sig-name">orient</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Orients the surface normals of all currently selected objects to the 
      given azimuth and altitude angles.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.orient">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#reverse" class="summary-sig-name">reverse</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Reverses the surface normals of the currently selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.reverse">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#revolve" class="summary-sig-name">revolve</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">axis</span>,
        <span class="summary-sig-arg">angle</span>,
        <span class="summary-sig-arg">segs</span>)</span><br />
      Revolves objects around axis , angle degrees, in segs segments.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.revolve">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#rotate" class="summary-sig-name">rotate</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Rotates the currently selected object(s) about the Transformation 
      Origin (see set.model.origin for more information).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.rotate">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#rotate_axis" class="summary-sig-name">rotate_axis</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">rotate_angle</span>)</span><br />
      Rotates the selected object(s) by the given angles in each axis.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.rotate_axis">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#rotate_reverse" class="summary-sig-name">rotate_reverse</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">azi</span>,
        <span class="summary-sig-arg">alt</span>)</span><br />
      Rotates the currently selected object(s) about the Transformation 
      Origin (see set.model.origin for more information), but in reverse 
      order.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.rotate_reverse">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#scale" class="summary-sig-name">scale</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">scale_factor</span>)</span><br />
      Scales currently selected objects by a factor of dx, dy and dz in the
      major axes.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.scale">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#spin" class="summary-sig-name">spin</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">angle</span>)</span><br />
      Rotates each selected object about its geometric centre, being the 
      axis of its surface normal.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.spin">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#ungroup" class="summary-sig-name">ungroup</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Removes the group status for the currently selected object(s).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.ungroup">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#unlink" class="summary-sig-name">unlink</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Removes any inter-object relationships from all currently selected 
      objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.unlink">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#update" class="summary-sig-name">update</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Updates the Selection Information panel.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.update">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#xform" class="summary-sig-name">xform</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">trans</span>,
        <span class="summary-sig-arg">function_values</span>)</span><br />
      Apply a generic transform to the selected object(s) in the model.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.xform">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#get_material" class="summary-sig-name">get_material</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the primary material index of all currently selected 
      objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.get_material">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#set_material" class="summary-sig-name">set_material</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>,
        <span class="summary-sig-arg">both</span>)</span><br />
      Sets the primary material index of all currently selected objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.set_material">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#get_type" class="summary-sig-name">get_type</a>(<span class="summary-sig-arg">self</span>)</span><br />
      Retrieves the element type of all selected objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.get_type">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="py2ecotect.doc.selection.Selection-class.html#set_type" class="summary-sig-name">set_type</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">type</span>,
        <span class="summary-sig-arg">state</span>=<span class="summary-sig-default">True</span>)</span><br />
      Sets the element type of all selected objects.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.set_type">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__init__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#alternate" class="summary-name">alternate</a><br />
      Retrieves the alternate material index of all currently selected 
      objects.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#area" class="summary-name">area</a><br />
      Retrieves the surface area (in m^2) of the current selection set, if 
      planar.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#attr_1" class="summary-name">attr_1</a><br />
      Retrieves the value for the attr1 slot of the current selection set.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#attr_2" class="summary-name">attr_2</a><br />
      Retrieves the value for the attr2 slot of the current selection set.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#attr_3" class="summary-name">attr_3</a><br />
      Retrieves the value for the attr3 slot of the current selection set.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#count" class="summary-name">count</a><br />
      Returns the number of objects in the current selection set.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#exposure" class="summary-name">exposure</a><br />
      Retrieves the surface area exposed to outside conditions (in m^2) of 
      the current selection set, if planar.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#length" class="summary-name">length</a><br />
      Retrieves the total length (m) of the current selection set, if 
      linear.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#next" class="summary-name">next</a><br />
      Returns the index of the next object in the current selection set.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#panel_area" class="summary-name">panel_area</a><br />
      Retrieves the surface overlapping a WINDOW / DOOR in adjacent zone 
      (m^2).
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#prev" class="summary-name">prev</a><br />
      Returns the index of the previous object in the current selection 
      set.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#resolution" class="summary-name">resolution</a><br />
      Retrieves the curve resolution for virtual polylines.
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a href="py2ecotect.doc.selection.Selection-class.html#underground" class="summary-name">underground</a><br />
      Retrieves the surface area exposed to ground conditions (m2), if 
      planar.
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="delete"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">delete</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.delete">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Deletes the currently selected object(s) from the model.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="duplicate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">duplicate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.duplicate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates a duplicate copy of currently selected object(s).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>offset_distance A list of three values that represent the offset 
  distance in each of the X, Y and Z axis, given in model coordinates, 
  where the duplicate will be placed.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="equation"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">equation</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.equation">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Recalculates the plane equations and surface areas of currently 
  selected object(s).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="extrude"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">extrude</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.extrude">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Extrudes currently selected object(s).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>offset_distance A list of three values that represent the offset 
  distance in each of the X, Y and Z axis, given in model coordinates, 
  where the duplicate will be placed.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="group"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">group</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.group">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Establishes a group for the currently selected object(s).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="link"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">link</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.link">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Creates inter-object relationship links between the currently selected
  objects. Such as establishing OBJECT_INSIDE and OBJECT_PLANAR links for 
  WINDOWS objects inside WALL objects.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="move"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">move</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">offset_distance</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.move">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Moves the currently selected object(s).</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>offset_distance A list of three values that represent the offset 
  distance in each of the X, Y and Z axis, given in model coordinates, 
  where the duplicate will be placed.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="normal"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">normal</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">type</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.normal">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Orients the surface normals of all currently selected objects in the 
  specified direction.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>type An integer value corresponding to the following Object Normals 
  table. Relevant Data Table(s) Object Normal Directions Value Description 
  0 Towards current sun position. 1 Towards positive X axis. 2 Towards 
  positive Y axis. 3 Towards positive Z axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="nudge"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">nudge</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">dir</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.nudge">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Nudges the currently selected objects along the given axis 
  direction.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>dir An integer value corresponding to the Nudge Direction table below.
  Relevant Data Table(s) Nudge Directions Value Description 1, -1 In the X 
  axis. 2, -2 In the Y axis. 3, -3 In the Z axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="orient"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">orient</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.orient">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Orients the surface normals of all currently selected objects to the 
  given azimuth and altitude angles.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>azi The azimuth angle in degrees.</p>
  <p>alt The altitude angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="reverse"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">reverse</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.reverse">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Reverses the surface normals of the currently selected object(s).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="revolve"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">revolve</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">axis</span>,
        <span class="sig-arg">angle</span>,
        <span class="sig-arg">segs</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.revolve">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Revolves objects around axis , angle degrees, in segs segments.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>axis An integer corresponding to the Axis table below. angle The angle
  of rotation in degrees. segs The number of segments to rotate by. 
  Relevant Data Table(s) Axis Types Value Description 0 Around the Z axis. 
  1 Around the X axis. 2 Around the Y axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.rotate">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates the currently selected object(s) about the Transformation 
  Origin (see set.model.origin for more information). This is done about 
  the Y axis first (altitude) and then the Z axis (aziumuth). You can also 
  use the app.cmd command to set the Transformation Origin about which the 
  rotation will occur.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>azi The aziumuth angle in degrees.</p>
  <p>alt The altitude angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate_axis"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate_axis</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">rotate_angle</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.rotate_axis">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates the selected object(s) by the given angles in each axis.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>rotate_angle A list of three values that represent the angle to rotate
  around the X-Axis, Y-Axis, and Z-Axis, in decimal degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="rotate_reverse"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">rotate_reverse</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">azi</span>,
        <span class="sig-arg">alt</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.rotate_reverse">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates the currently selected object(s) about the Transformation 
  Origin (see set.model.origin for more information), but in reverse order.
  This is necessary to properly undo a normal polar rotation.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>azi The aziumuth angle in degrees.</p>
  <p>alt The altitude angle in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="scale"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">scale</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">scale_factor</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.scale">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Scales currently selected objects by a factor of dx, dy and dz in the 
  major axes. See the selection.rotate command for information on 
  specifying the Transformation Origin.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>scale_factor A list of three values that represent the scaling factor 
  along the X, Y, Z Axis</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="spin"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">spin</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">angle</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.spin">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Rotates each selected object about its geometric centre, being the 
  axis of its surface normal.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>angle The angle of rotation in degrees.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="ungroup"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">ungroup</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.ungroup">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes the group status for the currently selected object(s).</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="unlink"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">unlink</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.unlink">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Removes any inter-object relationships from all currently selected 
  objects.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="update"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">update</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.update">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Updates the Selection Information panel. There are several ways to 
  select objects using script commands in ECOTECT. For example, the 
  selection commands are used to grab many objects in one call, so it is 
  logical for ECOTECT to automatically update the Selection Information 
  panel whenever one of these commands is used. However, when the 
  set.object.selected command is used to select/deselect individual 
  objects, this may be applied to several hundred objects in a large model,
  which would mean that updating the Selection Information panel at the end
  of each action would result in an unneccesary reduction in the speed of 
  the script. Thus, the Selection Information panel is not updated when the
  selection status of individual objects is changed, so you should use the 
  selection.update command when you have completed your selection.</p>
  <p>Parameter(s) There are no parameters for this command.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="xform"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">xform</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">trans</span>,
        <span class="sig-arg">function_values</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.xform">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Apply a generic transform to the selected object(s) in the model.</p>
  <p>Parameter(s) This command takes the following parameters.</p>
  <p>trans The transformation to use, given as a token corresponding to the
  following Transformation Types table.</p>
  <p>function_values A list of three values that represent the coordinate 
  values specified by the table below.</p>
  <p>Relevant Data Table(s)</p>
  <p>Transformation Types Token Description axis Axial rotation, where x , 
  y and z are axial angles in degrees. reverse Reverse polar rotation, 
  where x and y are azi and alt in degrees. rotate Polar rotation, where x 
  and y are azi and alt in degrees. move Translate objects by x , y and z 
  values in the major axis. scale Scale objects by x , y and z in the major
  axis. mirror Mirror objects around About Point and vector formed by x , y
  and z. normal Extrude objects a distance of x along its surface normal. 
  extrude Extrude objects by x , y and z in the major axis. revolve Revolve
  objects around axis x , y degrees and in z segments. nudge Nudge objects 
  a distance of x , y and z in the major axis.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_material"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_material</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.get_material">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the primary material index of all currently selected 
  objects. A negative result indicates that the material varies within the 
  selection.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the primary material assigned.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_material"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_material</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">index</span>,
        <span class="sig-arg">both</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.set_material">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the primary material index of all currently selected objects.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>index A zero-based index of the material to be assigned, as obtained 
  from the get.material.index property. This parameter can also be given as
  a string containing the material name, in which case it must not contain 
  any white-space characters and is case sensitive.</p>
  <p>both Determines whether the specified material is assigned to the 
  alternate material setting of selected objects as well. This is a boolean
  value where 1 or true represents the affirmative and 0 or false the 
  negative.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="get_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">get_type</span>(<span class="sig-arg">self</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.get_type">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Retrieves the element type of all selected objects. A negative result 
  indicates that the type varies within the selection.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>type An integer value corresponding to the following Element Types 
  table.</p>
  <p>Relevant Data Table(s) Element Types Token Value void 0 roof 1 floor 2
  ceiling 3 wall 4 partition 5 window 6 panel 7 door 8 point 9 speaker 10 
  light 11 appliance 12 line 13 solarcollector 14 camera 15</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<a name="set_type"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">set_type</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">type</span>,
        <span class="sig-arg">state</span>=<span class="sig-default">True</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="py2ecotect.doc.selection-pysrc.html#Selection.set_type">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Sets the element type of all selected objects.</p>
  <p>Parameter(s) This property takes the following parameters.</p>
  <p>type An integer value corresponding to the following Element Types 
  table.</p>
  <p>[state] An optional boolean parameter specifying if the default 
  material of the new element type is assigned to the material as well. 
  This parameter defaults to true.</p>
  <p>Relevant Data Table(s) Element Types Token Value void 0 roof 1 floor 2
  ceiling 3 wall 4 partition 5 window 6 panel 7 door 8 point 9 speaker 10 
  light 11 appliance 12 line 13 solarcollector 14 camera 15</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== PROPERTY DETAILS ==================== -->
<a name="section-PropertyDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Property Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-PropertyDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="alternate"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">alternate</h3>
  <p>Retrieves the alternate material index of all currently selected 
  objects. A negative result indicates that the alternate material varies 
  within the selection.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the alternate material assigned</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the alternate material index of all currently selected objects.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">index</span>)</span>
        - Sets the alternate material index of all currently selected objects.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">area</h3>
  <p>Retrieves the surface area (in m^2) of the current selection set, if 
  planar.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the surface area (in m^2) of the current selection set, if 
planar.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="attr_1"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">attr_1</h3>
  <p>Retrieves the value for the attr1 slot of the current selection 
  set.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the value for the attr1 slot of the current selection set.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the value for the attr1 slot of the current selection set.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="attr_2"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">attr_2</h3>
  <p>Retrieves the value for the attr2 slot of the current selection 
  set.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the value for the attr2 slot of the current selection set.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the value for the attr2 slot of the current selection set.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="attr_3"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">attr_3</h3>
  <p>Retrieves the value for the attr3 slot of the current selection 
  set.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the value for the attr3 slot of the current selection set.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the value for the attr3 slot of the current selection set.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="count"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">count</h3>
  <p>Returns the number of objects in the current selection set.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>count The number of objects in current selection set.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the number of objects in the current selection set.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="exposure"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">exposure</h3>
  <p>Retrieves the surface area exposed to outside conditions (in m^2) of 
  the current selection set, if planar.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the surface area exposed to outside conditions (in m^2) of the 
current selection set, if planar.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="length"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">length</h3>
  <p>Retrieves the total length (m) of the current selection set, if 
  linear.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the total length (m) of the current selection set, if linear.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="next"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">next</h3>
  <p>Returns the index of the next object in the current selection set. A 
  negative value indicates the end of the list.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the next selected object.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the index of the next object in the current selection set.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="panel_area"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">panel_area</h3>
  <p>Retrieves the surface overlapping a WINDOW / DOOR in adjacent zone 
  (m^2).</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the surface overlapping a WINDOW / DOOR in adjacent zone (m^2).
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="prev"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">prev</h3>
  <p>Returns the index of the previous object in the current selection set.
  A negative value indicates the end of the list.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>index The zero-based index of the next previous object.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Returns the index of the previous object in the current selection set.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="resolution"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">resolution</h3>
  <p>Retrieves the curve resolution for virtual polylines.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the curve resolution for virtual polylines.
    </dd>
    <dt>Set Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fset(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">value</span>)</span>
        - Sets the curve resolution for virtual polylines.
    </dd>
  </dl>
</td></tr></table>
</div>
<a name="underground"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <h3 class="epydoc">underground</h3>
  <p>Retrieves the surface area exposed to ground conditions (m2), if 
  planar.</p>
  <p>Parameter(s) There are no parameters for this property.</p>
  <p>Return Value(s) Getting this property returns the following 
  value(s).</p>
  <p>value A decimal value containing the specified data.</p>
  <dl class="fields">
    <dt>Get Method:</dt>
    <dd class="value"><span class="summary-sig"><i>unreachable</i>.fget(<span class="summary-sig-arg">self</span>)</span>
        - Retrieves the surface area exposed to ground conditions (m2), if planar.
    </dd>
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">
  <!-- Home link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="py2ecotect-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Project homepage -->
      <th class="navbar" align="right" width="100%">
        <table border="0" cellpadding="0" cellspacing="0">
          <tr><th class="navbar" align="center"
            >py2ecotect</th>
          </tr></table></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Fri Aug 28 01:29:47 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
